Contents

The following Help Topics are available:

Introduction

Main Window Functions

File Menu Functions

Edit Menu Functions

SQL Generation Functions

Table Definition Functions

Query Def Functions

Limitations

For Help on the Help, Press F1


Introduction

RI-VB Database Toolkit is a useful tool for developing Visual Basic® applications that use Access® or for manipulating data from an Access® database. RI-VB Database Toolkit includes the following features:

SQL Features:

Runs individual statements or scripts of SQL statements. Display the results of select statements in rows and columns.

Generates SQL create table and create index statements from an existing Access database.

Generates SQL insert statements from data in an existing Access database.

Display Features:

Generates database layouts for all or individual tables in an Access database.

Displays SQL stored in Access query defs.

Exporting and importing of query defs.

Output Features:

Table layouts, query defs, SQL statements can be printed or saved to text files.

Output can be copied to the MS Windows clipboard.  This is useful in Visual Basic development.

Other Features:

Database repair and compact functions

Edit and delete query defs

Run Query Defs


Main Window Functions

The main window is divided into two areas. The SQL Window covers the upper one-third portion of the main window.  In this area you can type one or more SQL statements and execute them by pressing Ctrl-Enter.  When executing multiple SQL statements, each statement must end with a semi-colon.  A script (text file) of SQL statements can be loaded in the SQL Window by selecting File | Open Script.

The lower two-thirds portion of the main window is called the Data Window. The output of the RI-VB Database Toolkit goes to this window where you can print, save to text file, and copy to the clipboard.


File Menu Functions

Create Database - Creates a new Access ®  database file.

Open Database - Opens an existing Access ® database.

Close Database - Closes the currently open database.

Open Script - Open a text file and copies it to the SQL Window.

Save Script - Saves the text in the current window to a file.

Print - Prints the text in the current window.

Output to File - Allows output to the Data Window to go directly to a text file. This is useful when the output to the Data Window exceeds the 32K.

Repair Database - Repairs and compacts* an Access ® database.

Compact Database - Compacts* an Access ® database.

Exit - Ends the program.

*The compacting process creates a backup version of the database file with the ".BAK" extention.


Edit Menu Functions

Cut - Copies and removes text from the current window to the clip board.

Copy - Copies text from the current window to the clip board.

Paste - Copies text from the clip board to the current window.

Select All - Highlights all the text in the current window.

Clear - Deletes the text in the current window.


SQL Generation Functions

Create Statements - Generates SQL table Create statements for the current database.

Insert Statements - Generates SQL Insert statements for the current database.


Table Definition Functions

All Tables - Generates table definitions for the entire database.

Table List - Allows the user to select and display the definition for a single table.


Query Def Functions

All Query Defs - Outputs, to the Data window, all the query defs for the current database.

Query Def List - Allows the user to display individual query defs.

Edit Query Defs - Allows the user to create, modify, and delete query defs from the current database.

Save Query Defs - Exports query defs to a temporary database or text file.

Install Query Defs - Imports query defs from a temporary database.

Run Query Def - Allows the user to select and run a query def.


Limitations

The RI-VB Database Toolkit has some limitations on the amount and the kinds of data it can handle.  The SQL Window and the Data Window can only hold about 32K of text.  When an operation tries to place more that this amount into a window the operation will be halted.  You can, however, specify in the file menu to send out put to a file.  This will send output to both the screen and the text file you select.  Once the 32K limit is reached, an error message box will be displayed.  Press the "OK" button on the message box and the rest of the data will be sent to the file.  Also, the RI-VB Database Toolkit cannot display data from memo or binary fields.


Open Database Dialog Box

Database Name and Path Combo box - lists the names and paths of up to 20 database files that have been accessed previously with RI-VB Database Toolkit. This list is stored in the RIDBTOOL.INI file.

Buttons

Select Database - Displays a file dialog box for selecting a database to open.

Open Database - Opens the selected database and closes the open database dialog box.

Clear Entry - removes the selected database from the list.

Cancel - Closes the dialog box without opening a database.


Query Def Edit Dialog Box
Edit Query Def Dialog Box

The Edit Query Def Dialog Box provides the ablity to view, add, modify or delete query defs.  You must make sure your modifications and additions are syntactically correct.

Buttons:

Edit - Loads the highlighted query def for editing.

New - Enables the dialog box to receive a new query def.

Save - Save a query def.

Delete - Delete the highlighted query def.

Close - Closes the Edit Query Def dialog box


Save Query Defs Dialog Box

The Save Query Defs Dialog Box allows the exporting of the currently opened database's query defs to a temporary database or a text file.  When making changes to query defs in mulitiple copies of a database you need only change the query defs in one copy of the database.  Then you export the query defs to a temporary database that can be used to update all the other copies of the database through the Install Defs procedure.

Buttons:

Save to Database Option - Specifies that query defs will be saved to an Access® database file.

Save to File Option - Specifies that query defs will be saved to a text file. This file cannot be used to import query defs into a database;

Destination - Provides a common file dialog box for the user to specify the path and name of the database/text file to which the data will be exported.

Save Defs - Creates the destination database and copies the current database's querys to it.

Close - Closes the Save Query Def dialog box.


Install Query Defs Dialog Box

The Install Query Defs Dialog Box provides the means to update query defs in the currently opened database from a temporary database file.

Buttons:

Source Database - Provides a common file dialog box for the user to specify the path and name of the database file from which the data will be imported.

Update Queries - Performs the insertion of queries into the current database.

Close - Closes the Install Query Defs dialog box.


Current Window

The section on the main window where the cursor is: either the SQL Window or the Data Window.


Command Line

You can add a database path and name to RI-VB Database Toolkit's command line under its properties in the Program Manager.  The database toolkit will attempt to open this file on program startup. Command Line example: C:\RIDBTOOL\RIDBTOOL.EXE c:\projects\order.mdb